API Issues #373

mrdavidorok · 2025-06-02T10:12:05Z

Description

Provide a brief overview of what this documentation update is about. Explain what sections or topics are being added or revised.

Linear ticket and magic word Fixes DEVR-942

Type of change

bolt-new-by-stackblitz · 2025-06-02T10:12:08Z

Run & review this pull request in StackBlitz Codeflow.

PoojaB26

Requested changes, please see the comments.

PoojaB26 · 2025-06-13T22:02:07Z

docs/troubleshooting/api/api_charset_and_encoding_fix_guide.md

+
+Follow the steps below: 
+
+- **Set Proper Request Headers**


These are steps, should this be numbered bullets or dot bullets?

PoojaB26 · 2025-06-13T22:02:48Z

docs/troubleshooting/api/api_charset_and_encoding_fix_guide.md

+
+    `Content-Type: application/json`
+
+    `Charset: utf-8`


There are two headers that needs to be added, shouldnt there be bullets?

PoojaB26 · 2025-06-13T22:05:18Z

docs/troubleshooting/api/client-server_errors_during_the_api_call.md

+
+This guide will help you understand the most common API error codes and how to fix them.
+
+## What is an API?


Remove this sub topic and add a single line about APIs such as To learn more about APIs, check out our API documentation guide and point it to our API docs. You can find it if you search for it. Please reference other guides to learn how we hyperlink internal docs.

PoojaB26 · 2025-06-13T22:06:00Z

docs/troubleshooting/api/client-server_errors_during_the_api_call.md

+    Your request isn’t properly formatted. This could be due to a missing parameter, a typo, or incorrect syntax.
+
+    :::tip
+    Check the API documentation to ensure you're including the correct fields and headers.


Suggested change

Check the API documentation to ensure you're including the correct fields and headers.

Check the API's own documentation to ensure you're including the correct fields and headers.

PoojaB26 · 2025-06-13T22:07:02Z

docs/troubleshooting/api/client-server_errors_during_the_api_call.md

+    The API server took too long to respond. Try simplifying your request or reducing the size of the data being sent.
+
+:::tip[Final tips]
+- Always check the API documentation, inspect your request, and look up error messages. If the issue persists, contact the API provider.


Suggested change

- Always check the API documentation, inspect your request, and look up error messages. If the issue persists, contact the API provider.

- Always check the API's own documentation, inspect your request, and look up error messages. If the issue persists, contact the API provider.

PoojaB26 · 2025-06-13T22:07:21Z

docs/troubleshooting/api/client-server_errors_during_the_api_call.md

+
+:::tip[Final tips]
+- Always check the API documentation, inspect your request, and look up error messages. If the issue persists, contact the API provider.
+- Once you fix the issue, your calls should return a `200 OK`—which means everything is working as expected!


Suggested change

- Once you fix the issue, your calls should return a `200 OK`—which means everything is working as expected!

- Once you fix the issue, your calls should return a `200 OK`, which means everything is working as expected!

Refrain from using double dashes in our documentation, please change everywhere.

PoojaB26 · 2025-06-13T22:09:14Z

docs/troubleshooting/api/securing_your_api_keys_in_private_api_calls.md

+
+Ensuring the security of API keys is a critical aspect of building and maintaining a safe and reliable application. In the realm of private API calls, it's especially important to make sure your API keys are not exposed. This article aims to provide a best-practices guide on where to place your API keys to increase security in a FlutterFlow environment.
+
+## The Misconception: Private API Calls Secure Everything


this doesnt need to be h2, just bold heading is fine.

PoojaB26 · 2025-06-13T22:09:59Z

docs/troubleshooting/api/securing_your_api_keys_in_private_api_calls.md

+
+Many users assume that simply marking an API call as 'private' is enough to protect all associated data. However, this is not the case. Private API calls run in a Cloud Function, which means any keys or sensitive data in the body will be secure — as long as they're not passed in from the frontend. Even in private API calls, if you're loading an API key from the frontend (like from Firebase remote configs), then you're still exposing it.
+
+## Where to Put Your API Keys


Not a good title, please think of an alternative

PoojaB26 · 2025-06-13T22:11:06Z

docs/troubleshooting/api/securing_your_api_keys_in_private_api_calls.md

+    ```
+    The key should never be a variable that gets passed in from the frontend, as that would make it accessible via the client-side code, defeating the purpose of using private API calls for secure operations.
+
+## How to verify that your key is secured


Refrain from using "How to" in titles , update the title accordingly and all our titles are written in Title Case.

PoojaB26 · 2025-06-13T22:11:58Z

docs/troubleshooting/api/understanding_api_errors.md

+slug: /understanding-api-errors
+title: Understanding API Errors
+---
+# Understanding API Errors


Whats the difference between this doc and client server errors doc? seems like similar info, merge the info and create a single doc.

David Edet Orok and others added 5 commits May 26, 2025 17:16

Add troubleshooting FAQ

b4fa662

Added API troubleshooting FAQ

90db42e

proper spacing

99e687a

Added more CodeMagic Deployment tips

b83d934

assets added, typos fixed, formating fixed.

ae0d11a

mrdavidorok marked this pull request as ready for review June 8, 2025 07:51

github-actions bot requested a review from PoojaB26 June 8, 2025 07:51

improved formatting and updated content.

f1208c1

PoojaB26 requested changes Jun 13, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

API Issues #373

API Issues #373

Uh oh!

mrdavidorok commented Jun 2, 2025

Uh oh!

bolt-new-by-stackblitz bot commented Jun 2, 2025

Uh oh!

PoojaB26 left a comment

Uh oh!

PoojaB26 Jun 13, 2025

Uh oh!

PoojaB26 Jun 13, 2025

Uh oh!

PoojaB26 Jun 13, 2025

Uh oh!

PoojaB26 Jun 13, 2025

Uh oh!

PoojaB26 Jun 13, 2025

Uh oh!

PoojaB26 Jun 13, 2025

Uh oh!

PoojaB26 Jun 13, 2025

Uh oh!

PoojaB26 Jun 13, 2025

Uh oh!

PoojaB26 Jun 13, 2025

Uh oh!

PoojaB26 Jun 13, 2025

Uh oh!

PoojaB26 Jun 13, 2025

Uh oh!

Uh oh!


		This guide will help you understand the most common API error codes and how to fix them.

		## What is an API?

	Check the API documentation to ensure you're including the correct fields and headers.
	Check the API's own documentation to ensure you're including the correct fields and headers.

	- Always check the API documentation, inspect your request, and look up error messages. If the issue persists, contact the API provider.
	- Always check the API's own documentation, inspect your request, and look up error messages. If the issue persists, contact the API provider.

	- Once you fix the issue, your calls should return a `200 OK`—which means everything is working as expected!
	- Once you fix the issue, your calls should return a `200 OK`, which means everything is working as expected!


		Ensuring the security of API keys is a critical aspect of building and maintaining a safe and reliable application. In the realm of private API calls, it's especially important to make sure your API keys are not exposed. This article aims to provide a best-practices guide on where to place your API keys to increase security in a FlutterFlow environment.

		## The Misconception: Private API Calls Secure Everything


		Many users assume that simply marking an API call as 'private' is enough to protect all associated data. However, this is not the case. Private API calls run in a Cloud Function, which means any keys or sensitive data in the body will be secure — as long as they're not passed in from the frontend. Even in private API calls, if you're loading an API key from the frontend (like from Firebase remote configs), then you're still exposing it.

		## Where to Put Your API Keys

API Issues #373

Are you sure you want to change the base?

API Issues #373

Uh oh!

Conversation

mrdavidorok commented Jun 2, 2025

Description

Type of change

Uh oh!

bolt-new-by-stackblitz bot commented Jun 2, 2025

Uh oh!

PoojaB26 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!